Messaging Class Reference

Public Member Functions
	__construct ($userID)
	sendMessage (&$recipients, $subject, $message, $asEmail=0, $saveInOutbox=true)
	sameNameUsers ($userID)
	markMessageAsRead ($messageID)
	deleteMessage ($messageID, $type)
	archiveMessage ($messageID, $type)
	getRecipients ($RecipientsID, $limit, $breaks)
	getOrderByLink ($feld)
	getUserID ()
	getRole ()
	getDB ()
Static Public Member Functions
static	includeMessagingCSSFile ()
static	getAutoSearchJavaScript ()
static	setGlobalVariables ()

---

Detailed Description

Definition at line 49 of file class.messaging.inc.php.

---

Constructor & Destructor Documentation

__construct

(

$

userID

)

Konstruktor: Stellt die UserID den Methoden zur Verfuegung. public

Parameters:

integer

$userID Uebergabe der UserID des eingeloggten Users.

Returns:

void

Definition at line 81 of file class.messaging.inc.php.

---

Member Function Documentation

archiveMessage	(	$	messageID,
		$	type
	)

Setzt den Status der Nachricht auf archiviert. public

Parameters:

	integer	$messageID ID, der zu archiverenden Nachricht
	string	$type Bestimmt ob sich die Nachricht in der In- oder Outbox befindet

Returns:

void

Definition at line 289 of file class.messaging.inc.php.

deleteMessage	(	$	messageID,
		$	type
	)

Loescht Nachricht. public

Parameters:

	integer	$messageID ID, der zu loeschenden Nachricht
	string	$type Bestimmt ob sich die Nachricht in der In- oder Outbox befindet

Returns:

true falls erfolgreich, ansonsten false

Definition at line 266 of file class.messaging.inc.php.

static getAutoSearchJavaScript

(

)

[static]

Liefert einen String, der den Include Code für das AutoSearch und Autocompletion Javascript enthält public

Returns:

string String mit Javascript Include

Definition at line 403 of file class.messaging.inc.php.

getDB

(

)

Liefert das DB-Access Objekt public

Returns:

DB-Access Objekt

Definition at line 377 of file class.messaging.inc.php.

getOrderByLink

(

$

feld

)

Gibt in der In- und Sentbox einen Header aus, der die Nachrichten sortieren laesst. public

Parameters:

string

$feld

Returns:

String "auf" oder "ab"

Definition at line 333 of file class.messaging.inc.php.

getRecipients	(	$	RecipientsID,
		$	limit,
		$	breaks
	)

Gibt die Empfaengerliste einer Nachricht zurueck public

Parameters:

	string	$RecipientsID ID, der Empfaenger (ID1; ID2;...)
	integer	$limit Gibt an wiviele Empfaenger in der Liste ausgegeben werden sollen.
	integer	$breaks Gibt an nach wievielen Namen ein erfolgt

Returns:

void

Definition at line 303 of file class.messaging.inc.php.

getRole

(

)

Liefert die Rolle des Benutzers public

Returns:

Rolle des aktuellen Benutzers

Definition at line 364 of file class.messaging.inc.php.

getUserID

(

)

Liefert die UserID public

Returns:

integer UserID des aktuellen Benutzers

Definition at line 351 of file class.messaging.inc.php.

static includeMessagingCSSFile

(

)

[static]

Diese Klassenmethode fügt die CSS Datei in den eStudy Header ein. Der Aufruf muss vor den eStudy-Includes kommen! public

Definition at line 390 of file class.messaging.inc.php.

markMessageAsRead

(

$

messageID

)

Markiert eine Nachricht als gelesen

Parameters:

integer

$messageID, ID der Nachricht

Definition at line 250 of file class.messaging.inc.php.

sameNameUsers

(

$

userID

)

Gibt die Anzahl der Benutzer zurück, die den gleich Vor- und Nachnamen haben wie der übergebene

public

Parameters:

int

$userID ID des Benutzers

Returns:

int Anzahl der Benutzer mit selbem Namen

Definition at line 240 of file class.messaging.inc.php.

sendMessage	(	&$	recipients,
		$	subject,
		$	message,
		$	asEmail = 0,
		$	saveInOutbox = true
	)

Sendet die Nachricht an den angegeben User public

Parameters:

	string	&$recipients Referenzangabe der Empfaengerliste (Nachname, Vorname...
	string	$subject Betreffzeile
	string	$message Nachrichtentext
	bool	$asEmail Versenden als E-Mail
	bool	$saveInOutbox Nachricht wird in Outbox gespeichert

Returns:

true falls erfolgreich, andernfalls false

Definition at line 108 of file class.messaging.inc.php.

static setGlobalVariables

(

)

[static]

Setzt die globalen Variablen die im Modul benötigt werden. public

Zur Benutzung von SSL-Verschlüsselung vorsehen

Definition at line 411 of file class.messaging.inc.php.

---

The documentation for this class was generated from the following file:

• /home/hrniels/htdocs/eStudy/web/messaging/classes/class.messaging.inc.php